Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating use_substring comment for log-levels #2332

Merged
merged 1 commit into from
Mar 19, 2024
Merged

Updating use_substring comment for log-levels #2332

merged 1 commit into from
Mar 19, 2024

Conversation

manumafe98
Copy link
Contributor

The goal is to make the comment more clear for students

Related: #151

@github-actions github-actions bot added track/java Java track type/analyzer-comments Analyzer comments labels Mar 19, 2024
@manumafe98 manumafe98 mentioned this pull request Mar 19, 2024
Merged
2 tasks
@IsaacG IsaacG merged commit 7d6cc7b into exercism:main Mar 19, 2024
1 check passed
@sanderploegsma
Copy link
Contributor

🤔 I'm not sure this should have been merged without the corresponding changes to the analyzer. Right now the copy contains a parameter but the analyzer doesn't provide the parameter in its output, so my guess is that the copy renders incorrectly for students...

@manumafe98
Copy link
Contributor Author

🤔 I'm not sure this should have been merged without the corresponding changes to the analyzer. Right now the copy contains a parameter but the analyzer doesn't provide the parameter in its output, so my guess is that the copy renders incorrectly for students...

Uf you're right and we need erik approval to merge the analyzer

@IsaacG
Copy link
Member

IsaacG commented Mar 20, 2024

Should we push a revert PR?

@sanderploegsma
Copy link
Contributor

Yes I think that is best. And going forward we should try to avoid making breaking changes to existing comments.

Instead, we can consider creating a new version comment_name_v2.md next to the original one, so that we can safely update the analyzer asynchronously.

sanderploegsma added a commit to sanderploegsma/exercism-website-copy that referenced this pull request Mar 20, 2024
@sanderploegsma
Revert "analyzer-comments/java/log-levels: Updating use substring com…
e31402a 
…ment so it tells where to apply substring (exercism#2332)"

This reverts commit 7d6cc7b.
@sanderploegsma sanderploegsma mentioned this pull request Mar 20, 2024
Merged
@sanderploegsma
Copy link
Contributor

See #2333

IsaacG pushed a commit that referenced this pull request Mar 20, 2024
@sanderploegsma
[java/log-levels] Fix breaking change in existing comment (#2333)
c542c5f 
* Revert "analyzer-comments/java/log-levels: Updating use substring comment so it tells where to apply substring (#2332)"

This reverts commit 7d6cc7b.

* Add use_substring_method_v2.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IsaacG IsaacG IsaacG approved these changes

Assignees
No one assigned
Labels
track/java Java track type/analyzer-comments Analyzer comments
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@manumafe98 @sanderploegsma @IsaacG